home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / xstatus.arc / XS.DOC < prev    next >
Encoding:
Text File  |  1987-12-30  |  9.5 KB  |  409 lines
  1.       
  2.  
  3.                             XStatus Version 1.81
  4.  
  5.                               December 30, 1987
  6.  
  7.            Copyright (C) 1987 InterZone Inc. All rights reserved.
  8.  
  9.  
  10.                   Available from FidoNet(Tm) node 1:135/20
  11.                              INTL-(305)-387-1135
  12.                     Operating 24 hrs at 300/1200/2400bps
  13.  
  14.  
  15.                   Suggestions welcome --- Complaints > NUL
  16.  
  17.                     "It's just another brick in the wall"
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.                             An Opus(noTm) Utility                        
  67.  
  68.  
  69.        XStatus                   User Manual                     Page   1
  70.  
  71.  
  72.       This is XStatus..  an advanced Opus  user  statistics  utility.   I
  73.       wanted  to  have  something that users could look at --- to sort of
  74.       start a competition between users.  Who  could  upload  the  most..
  75.       and who was the one downloading all the time etc.  
  76.  
  77.       After  that it was released to the public and I guess you could say
  78.       it was taken with open arms.  Since then I have added quite  a  few
  79.       functions..  and increased the speed with which the program process 
  80.       your  data.   One  important  thing  about  this utility was that I
  81.       didn't want it to be a pain to operate and setup.  And  I  think  I
  82.       managed  to  complete  that  goal.  You should be able to have this
  83.       program up and running within 15 minutes (or less).  
  84.  
  85.       This documentation will probably not help you much at all, it is so 
  86.       simple to set up the utility, but I will try to explain it in short 
  87.       just to give you a hand.  
  88.  
  89.       The program can be used doing two things (although the combinations 
  90.       within these two are quite a few)..  1) Create  'posters'  of  user
  91.       statistics  and  2)  Maintain the last ten callers automaticall and
  92.       create a 'Last Callers:' display found on systems like  'WWIV'  and
  93.       'PC-Forum' just to name a few.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.                             An Opus(noTm) Utility                        
  135.  
  136.  
  137.        XStatus                   User Manual                     Page   2
  138.  
  139.  
  140.       Everything  (except  the  updates  of  the  last  callers  log)  is
  141.       controlled from the control file (from now on referred  to  as  the
  142.       CTL  file) in which you will enter information about path names and
  143.       options.  You can for instance specify that  you  want  a  'Top  10
  144.       listing'  of  Uploaders  on  your  system.  If you get lost in this
  145.       document..  looking at the CTL file should give you enough clues on 
  146.       how to set things up.  The commands (found in XS.CTL) will  now  be
  147.       explained.  
  148.  
  149.       USER 
  150.  
  151.       This  specifies where the program is to look for the USER.BBS (file
  152.       with user information.  Some system operators call  this  something
  153.       else.) file.  
  154.  
  155.       LASTUSER 
  156.  
  157.       This  specifies  where  the program is to look for the LASTUSER.BBS
  158.       file (if you have multiple Opus board running on the same  machine,
  159.       you  can  use  wildcards  in the file specification and the program
  160.       will select the most recent updated file ie.  C:pusastUser.*).  
  161.  
  162.       MAXUSER 
  163.  
  164.       When the program creates the 'status posters' it will list the  top
  165.       or  bottom  users  in  each  category (Downloads, Uploads and Times
  166.       called).  With this option, you can specify how many users  are  to
  167.       be included on each poster.  Personally, I use 15 which fits pretty 
  168.       good on a 80x25 display.  
  169.  
  170.       MAXPRIV 
  171.  
  172.       This  specifies  the  maximum privilege level allowed for a user to
  173.       appear in the 'Last Callers:' list and the 'status posters'.  Valid 
  174.       options are Twit, Disgrace, Normal, Extra, Priv,  AsstSysop,  Sysop
  175.       and Hidden.  
  176.  
  177.       MINPRIV 
  178.  
  179.       This  specifies  the  minimum privilege level allowed for a user to
  180.       appear in the 'Last Callers:' list and the 'status posters'.  Valid 
  181.       options are Twit, Disgrace, Normal, Extra, Priv,  AsstSysop,  Sysop
  182.       and Hidden.  
  183.  
  184.       CONTROL 
  185.  
  186.       If  you  want  the  program to insert the oVIDEO sequence for pause
  187.       (which will give the  user  'Press  ENTER  to  continue')  in  your
  188.       posters  and last callers list, enable this option (make sure it is
  189.       not commented).  
  190.  
  191.       OVIDEO 
  192.  
  193.       Specifies that  the  program  will  use  the  oVIDEO  sequences  to
  194.       manipulate output, note that this requires Opus v1.00 or above.  If 
  195.       you  want  to  give  the user the option of colors, you need to use
  196.       this option.  
  197.  
  198.       COLORS 
  199.  
  200.  
  201.  
  202.                             An Opus(noTm) Utility                        
  203.  
  204.  
  205.        XStatus                   User Manual                     Page   3
  206.  
  207.       Specifies what colors to use.  If you are using the oVIDEO  option,
  208.       the program will insert colors.  You can define these colors to fit 
  209.       your system better.  They follow the standard IBM convention..  you 
  210.       will  have to experiment with this to get it to suit you best (Look
  211.       in the file COLORS.DOC) for a closer explanation on what colors are 
  212.       available.  
  213.  
  214.       NOCOPYRIGHT 
  215.  
  216.       Normally, the program will  insert  a  copyright  notice  into  the
  217.       'status  posters'  it  creates.   If  you  feel that you don't like
  218.       displaying these credits, you can use this option.  
  219.  
  220.       RATIO 
  221.  
  222.       This option will only be active in the download and upload posters.  
  223.       If you use this option the  representing  opposite  optio  will  be
  224.       shown  as  well.   Ie.   on the upload poster, the user's downloads
  225.       will be shown in ()s and on the download poster, the user's uploads 
  226.       will be shown in ()s.  If you do not wish to use this  option,  the
  227.       user's City and State will be shown instead.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.                             An Opus(noTm) Utility                        
  271.  
  272.  
  273.        XStatus                   User Manual                     Page   4
  274.  
  275.  
  276.       About the "LASTLOG" options The lastlog TMP and OUT options defined 
  277.       in the CTL file works as follows:  The TMP file is used to keep the 
  278.       last  ten  callersin a compact internal XS format.  The OUT file is
  279.       the file created (updated) each time a caller loggs off.  
  280.  
  281.       INSERT 
  282.  
  283.       When display the 'posters' from a menu or bulletin created by  you,
  284.       you usually want Opus* to chain back to that menu or bulletin after 
  285.       the  user  is  done viewing the 'poster'.  One way to do this is to
  286.       copy files together, ie.  copy the 'poster' from XStatus +  a  tail
  287.       file    to    create    the    necessary    chain    command   (ie.
  288.       ^O^SC:\Opus\Misc\Menu).  The insert command replaces  the  copy  or
  289.       echo  procedure.  You specify what the INSERT data is to be and the
  290.       program will append that line to the appropriate list.  
  291.  
  292.       NOTE:  The example above and then examples in the CTL file supplied 
  293.       with this package have the character to show that the character is  
  294.       actually a control character.  
  295.  
  296.       RATIO 
  297.  
  298.       If  the  RATIO  command  is found (and active) in the CTL file, the
  299.       opposite value of whatever list-type is  being  processed  will  be
  300.       shown after the amount (confused?).  If downloads are processed and 
  301.       RATIO  is  active,  uploads will be shown after the download amount
  302.       and the other way around).  If however, this command is NOT active, 
  303.       the user's location (city, state (country)) will be inserted in the 
  304.       'poster' instead.  
  305.  
  306.       PRIVILEGE LEVELS 
  307.  
  308.       Privilege levels to  be  included  can  be  defined  with  the  two
  309.       commands MAXPRIV and MINPRIV in the control file.  
  310.  
  311.       ERRORLEVELS 
  312.  
  313.       When  the  program  returns  to  the calling process (most likely a
  314.       batch file) it will also return a 'errorlevel' which will be set to 
  315.       the current process status.  The following values apply:  
  316.  
  317.       (5) Command ok, but needs more arg(s).  
  318.  
  319.       (4) Unrecognized command or command parameter(s) in CTL file.  
  320.  
  321.       (3) Privilege level of last user was below the minimum or above the 
  322.       maximum privilege levels (MINPRIV and MAXPRIV) defined by  you,  no
  323.       updates were made.  
  324.  
  325.       (2) No records found to process when creating list.  
  326.  
  327.       (1) File Access error(s).  File not found, etc etc.  
  328.  
  329.       (0) Program completed as expected 
  330.  
  331.       SEE ALSO 
  332.  
  333.       Please  see the "LastCall.Bat" file how I use the L option added in
  334.       v1.6 
  335.  
  336.  
  337.  
  338.                             An Opus(noTm) Utility                        
  339.  
  340.  
  341.        XStatus                   User Manual                     Page   5
  342.  
  343.       For fixes and new features, look in the file 'Fixes.Doc'.  
  344.  
  345.       STATUS 
  346.  
  347.       This program  is  hereby  declared  *myware*.   No  warranties,  no
  348.       nothing  ...  just the program and manual as *IS*.  One more thing,
  349.       I know this manual 'aint no artwork, but hey, it's not  the  doing,
  350.       it's the thinking!  
  351.  
  352.       Send bug reports and suggestions to 1:135/20 or to the below listed 
  353.       address.  
  354.       
  355.           Joaquim Homrighausen
  356.           11125 SW 132 Ct. #3
  357.           Miami FL 33186
  358.           USA
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.                             An Opus(noTm) Utility                        
  407.  
  408.  
  409.